Delete template from storage pool instantly if no volume is using it #11782

abh1sar · 2025-10-03T08:48:25Z

Description

This PR fixes #10688

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

#	Scenario	Action	Observed Result
1	`template.delete.from.primary.storage` setting toggle	Delete template with setting true vs false	Template file deleted only if setting is true
2	Instance created from template, then template deleted with force=true	Delete template (force) without deleting the instance	Template file not deleted from Primary Storage
3	Template installed on 2 zones, VMs created and expunged everywhere	Delete template without specifying `zoneId`	Template files deleted from all Primary Storages
4	Template installed on 2 zones, VMs created and expunged everywhere	Delete template specifying only `zoneId=zoneA`	Template file deleted only on Primary Storages belonging to zoneA

How did you try to break this feature and the system with this change?

codecov · 2025-10-03T08:56:06Z

Codecov Report

❌ Patch coverage is 8.51064% with 43 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.17%. Comparing base (c631d6a) to head (0d316b5).
⚠️ Report is 2 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...n/java/com/cloud/template/TemplateManagerImpl.java	0.00%	23 Missing ⚠️
...a/com/cloud/storage/dao/VMTemplatePoolDaoImpl.java	0.00%	7 Missing ⚠️
.../storage/datastore/db/PrimaryDataStoreDaoImpl.java	30.00%	7 Missing ⚠️
.../com/cloud/template/HypervisorTemplateAdapter.java	0.00%	6 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.20   #11782      +/-   ##
============================================
- Coverage     16.17%   16.17%   -0.01%     
+ Complexity    13298    13297       -1     
============================================
  Files          5656     5656              
  Lines        498242   498282      +40     
  Branches      60458    60466       +8     
============================================
+ Hits          80584    80590       +6     
- Misses       408686   408722      +36     
+ Partials       8972     8970       -2

Flag	Coverage Δ
uitests	`4.00% <ø> (ø)`
unittests	`17.02% <8.51%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

abh1sar · 2025-10-03T09:20:30Z

@blueorangutan package

blueorangutan · 2025-10-03T09:22:04Z

@abh1sar a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

server/src/main/java/com/cloud/template/TemplateManagerImpl.java

weizhouapache

code lgtm

thanks @abh1sar

weizhouapache · 2025-10-03T10:34:12Z

@blueorangutan package

blueorangutan · 2025-10-03T10:36:03Z

@weizhouapache a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-10-03T10:55:43Z

Packaging result [SF]: ✔️ debian. SL-JID 15274

blueorangutan · 2025-10-03T11:49:54Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15276

weizhouapache · 2025-10-03T12:33:06Z

@blueorangutan test

blueorangutan · 2025-10-03T12:34:05Z

@weizhouapache a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-10-04T04:57:05Z

[SF] Trillian test result (tid-14517)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 55925 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11782-t14517-kvm-ol8.zip
Smoke tests completed. 140 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_13_retrieve_vr_default_files	`Error`	1.14	test_diagnostics.py
test_14_retrieve_vr_one_file	`Error`	1.14	test_diagnostics.py
test_15_retrieve_ssvm_default_files	`Error`	1.14	test_diagnostics.py
test_16_retrieve_ssvm_single_file	`Error`	1.14	test_diagnostics.py
test_17_retrieve_cpvm_default_files	`Error`	0.11	test_diagnostics.py
test_18_retrieve_cpvm_single_file	`Error`	1.13	test_diagnostics.py

harikrishna-patnala · 2025-10-05T10:52:14Z

engine/components-api/src/main/java/com/cloud/template/TemplateManager.java

            + "will validate if the provided URL is resolvable during the register of templates/ISOs before persisting them in the database.",
            true);

+    ConfigKey<Boolean> TemplateDeleteFromPrimaryStorage = new ConfigKey<Boolean>("Advanced",


@abh1sar do we really need a global setting for this usecase, I think we can directly delete the template if there is no usage found.

@harikrishna-patnala I added it as a failsafe or in case someone doesn't care about how faster the space is reclaimed, but doesn't want to risk any kind of data loss. Also in case someone wants to use the setting storage.template.cleanup.enabled=false or storage.cleanup.enabled=false where the deleted template is never cleaned up.

Copilot

Pull Request Overview

This PR adds functionality to immediately delete template files from primary storage when templates are deleted, controlled by a new configuration setting. The feature helps prevent storage accumulation of unused template files by proactively evicting them during template deletion operations.

Introduces template.delete.from.primary.storage configuration key to toggle instant template deletion from primary storage
Refactors template usage checking logic into reusable method templateIsUnusedInPool()
Adds new method evictTemplateFromStoragePoolsForZones() to delete templates from specific zones

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
TemplateManagerImpl.java	Core implementation of template eviction logic with new configuration key
HypervisorTemplateAdapter.java	Integration of eviction calls during template deletion workflow
PrimaryDataStoreDaoImpl.java	Database layer support for querying storage pools by data center IDs
PrimaryDataStoreDao.java	Interface addition for data center-based pool queries
VMTemplatePoolDaoImpl.java	Database implementation for querying template-pool relationships
VMTemplatePoolDao.java	Interface addition for template-pool relationship queries
TemplateManager.java	Interface definitions for new template eviction functionality

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

engine/schema/src/main/java/com/cloud/storage/dao/VMTemplatePoolDaoImpl.java

Delete template from storage pool instantly if no volume is using it.

a7ed2a8

boring-cyborg bot added the component:storage label Oct 3, 2025

weizhouapache reviewed Oct 3, 2025

View reviewed changes

server/src/main/java/com/cloud/template/TemplateManagerImpl.java Outdated Show resolved Hide resolved

weizhouapache approved these changes Oct 3, 2025

View reviewed changes

Use CollectionUtils for empty check

0d316b5

harikrishna-patnala reviewed Oct 5, 2025

View reviewed changes

weizhouapache added this to the 4.20.2 milestone Oct 6, 2025

weizhouapache linked an issue Oct 6, 2025 that may be closed by this pull request

Deleting template does not remove the template images on primary storages #10688

Open

weizhouapache self-assigned this Oct 6, 2025

vishesh92 requested a review from Copilot October 7, 2025 12:48

Copilot AI reviewed Oct 7, 2025

View reviewed changes

engine/schema/src/main/java/com/cloud/storage/dao/VMTemplatePoolDaoImpl.java Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Delete template from storage pool instantly if no volume is using it #11782

Delete template from storage pool instantly if no volume is using it #11782

Uh oh!

abh1sar commented Oct 3, 2025

Uh oh!

codecov bot commented Oct 3, 2025 •

edited

Loading

Uh oh!

abh1sar commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

Uh oh!

weizhouapache left a comment

Uh oh!

weizhouapache commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

weizhouapache commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 4, 2025

Uh oh!

harikrishna-patnala Oct 5, 2025

Uh oh!

abh1sar Oct 6, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Delete template from storage pool instantly if no volume is using it #11782

Are you sure you want to change the base?

Delete template from storage pool instantly if no volume is using it #11782

Uh oh!

Conversation

abh1sar commented Oct 3, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

abh1sar commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

weizhouapache commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

weizhouapache commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 3, 2025

Uh oh!

blueorangutan commented Oct 4, 2025

Uh oh!

harikrishna-patnala Oct 5, 2025

Choose a reason for hiding this comment

Uh oh!

abh1sar Oct 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Oct 3, 2025 •

edited

Loading